Marketplace miberezi 2020 by MiriBerezin · Pull Request #12495 · Azure/azure-rest-api-specs

MiriBerezin · 2021-01-19T14:03:28Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
new API version for new APIs
When you are targeting to deploy new service/feature to public regions? 24/1/2021
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…rezin/azure-rest-api-specs into Marketplace-miberezi-2020

openapi-workflow-bot · 2021-01-19T14:03:31Z

Hi, @MiriBerezin Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-01-19T14:03:34Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 34 Warnings warning [Detail]

Only 10 items are listed, please refer to log for more details.

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- marketplace/resource-manager/readme.md tag:package-composite-v1
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- marketplace/resource-manager/readme.md tag:default

Rule	Message
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStore_GetApprovalRequestsList' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L113
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStore_AdminRequestApprovalsList' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L316
⚠️ R1005 - GetInOperationName	'GET' operation 'PrivateStore_AdminRequestApprovalsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L316
⚠️ R1006 - PutInOperationName	'PUT' operation 'PrivateStore_UpdateAdminRequestApproval' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L386
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L937
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateStore_GetApprovalRequestsList' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L109
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateStore_AdminRequestApprovalsList' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L312
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L32
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L71
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L113

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 14 Warnings warning [Detail]

Only 10 items are listed, please refer to log for more details.

Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2020-01-01/Marketplace.json <---> new: stable/2020-12-01/Marketplace.json

Rule	Message
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L19:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L61:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L106:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L247:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L333:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L375:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/operations' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L478:5
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'PrivateStoreOperation' removed or renamed? New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3 Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'PrivateStore' removed or renamed? New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3 Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'PrivateStoreProperties' removed or renamed? New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3 Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-01-19T14:03:35Z

Swagger Generation Artifacts

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8d7208b. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/marketplace/resource-manager/readme.md

️✔️marketplace [View full logs] [Release Schema Changes]

cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager]  optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8d7208b. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/marketplace/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.Marketplace [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.Marketplace.2.0.0-preview.nupkg
- Microsoft.Azure.Management.Marketplace.2.0.0-preview.snupkg

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-01-19T14:16:11Z

Hi @MiriBerezin, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

...source-manager/Microsoft.Marketplace/stable/2020-12-01/examples/AcknowledgeNotification.json

...source-manager/Microsoft.Marketplace/stable/2020-12-01/examples/GetApprovalRequestsList.json

...urce-manager/Microsoft.Marketplace/stable/2020-12-01/examples/AdminRequestApprovalsList.json

...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json

jorgecotillo · 2021-02-01T22:50:10Z

Are your POST and PUT operations long running operations? If yes, you need to conform to this

MiriBerezin · 2021-02-01T22:54:04Z

@jorgearteiro no, our APIs are NOT long-running operations

jorgecotillo · 2021-02-01T23:02:47Z

@jorgearteiro no, our APIs are NOT long-running operations

Ok. There's an important checkbox that was not marked:

[] I have reviewed the documentation for the workflow.

We'll let it pass this time, but future PRs if the documentation was not read prior creating the PR, the PR would not be reviewed.

MiriBerezin and others added 22 commits October 19, 2020 18:29

FIxing Privatestore ,Offer properties and examples

616529c

Fixing properties types

db39aba

Fixing camel cases

cbcdaa5

Add Idempotence to custom-words.txt

39f51f9

prettier check changes

52c20df

adding description to isGov

277c8a8

resolve conflicts

0576586

Merge branch 'master' into Marketplace-miberezi-2020

47c8ecd

Fix updateSuppressedDueIdempotence type

363fb45

Merge branch 'Marketplace-miberezi-2020' of https://github.com/MiriBe…

bc79982

…rezin/azure-rest-api-specs into Marketplace-miberezi-2020

Merge branch 'master' into Marketplace-miberezi-2020

47ee152

FIx swagger validation issues

03b64d4

Fix json

69d47e1

Fix indentation conflicts

d78f981

Merge branch 'master' into Marketplace-miberezi-2020

1e4f311

Fix corruption

e059350

Fix validations

b54a2bc

FIx marketplace swagger

6160386

Merge branch 'master' into Marketplace-miberezi-2020

ae3b2d1

Merge branch 'master' into Marketplace-miberezi-2020

64143de

new notifications apis

4ca8b6b

prettier check run

9f5c4af

openapi-assignment-bot bot assigned qianwens Jan 19, 2021

Fix spell check

8485982

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 19, 2021

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jan 19, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Feb 1, 2021

fix tests

5b01fa4